SpringBoot 属性外置配置

SpringBoot：1.5.9.RELEASE
JDK：1.8
IDEA：2017.2

@Value 注解读取 application.properties 文件中的属性

Controller：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExConfigController {

	@Value("${my.user.name}")
	private String name;

	@GetMapping("/user/name")
	public String getUserName() {
		System.out.println(name);
		return name;
	}

}

application.properties：

my.user.name=Hello-孙悟空

中文乱码问题

该方式有时会遇到中文乱码问题，此时可能需要检查一下application.properties文件的编码格式。
以 IDEA 为例：
File -> Settings -> File Encoding
将Properties Files (*.properties)下的Default encoding for properties files设置为UTF-8，将Transparent native-to-ascii conversion前的勾选上。

yml 默认就是 UTF-8 格式，所以天然支持中文。推荐使用 application.yml 替代 application.properties

@ConfigurationProperties 注解及配置类读取 application.properties 或 application.yml 文件中的属性

application.yml：

my.book.author: 罗贯中
my.book.name: 三国演义
my.book.price: 60

ExConfig :

package com.example.ec.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "my.book")
public class ExConfig {

	private String name;
	private String author;
	private int price;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getAuthor() {
		return author;
	}

	public void setAuthor(String author) {
		this.author = author;
	}

	public int getPrice() {
		return price;
	}

	public void setPrice(int price) {
		this.price = price;
	}
}

ExConfigController：

package com.example.ec.controller;

import com.example.ec.config.ExConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExConfigController {

	@Autowired
	private ExConfig exConfig;

	@GetMapping("/book")
	public String getBook() {
		return exConfig.getAuthor() + " " + exConfig.getName() + " " + exConfig.getPrice();
	}

}

不同的 SpringBoot 版本使用方式又些许不同。一些低版本的需要在启动类中配置 @EnableConfigurationProperties 注解

@ConfigurationProperties 注解及配置类读取 custom.properties 或 custom.yml 文件中的属性

读取自定义属性文件中的属性

book.yml：

my.book.author: 罗贯中
my.book.name: 三国演义
my.book.price: 60

ExConfig :

package com.example.ec.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@ConfigurationProperties(prefix = "my.book")
@PropertySource(value = "book.yml", encoding = "UTF-8")
public class ExConfig {

	private String name;
	private String author;
	private int price;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getAuthor() {
		return author;
	}

	public void setAuthor(String author) {
		this.author = author;
	}

	public int getPrice() {
		return price;
	}

	public void setPrice(int price) {
		this.price = price;
	}
}

具体代码已上传GitHub-lxmuse

赏

谢谢你请我吃糖果